RAIS  3.2
RAIS::Common::UserManagement::UserData Class Reference

This class encapsulates all user properties. More...

Inheritance diagram for RAIS::Common::UserManagement::UserData:
RAIS::Common::DBObject

List of all members.

Public Types

enum  DataRoleIndication { DataRole, Facility, DataRole, Facility }
enum  UserType {
  Administrator, Regulator, RestrictedAccessRegulator, Licensee,
  Guest, Other, Admin, Regulator,
  Licensee, PublicBody, Guest
}
enum  UserStatus {
  Active, NotActive, LoggedOn, Locked,
  LoggedOff
}
enum  DataRoleIndication { DataRole, Facility, DataRole, Facility }
enum  UserType {
  Administrator, Regulator, RestrictedAccessRegulator, Licensee,
  Guest, Other, Admin, Regulator,
  Licensee, PublicBody, Guest
}

Public Member Functions

 UserData ()
 UserData (IDataRecord record)
bool HasAccessToCategory (string categoryName)
override string ToString ()
 UserData ()
 UserData (IDataRecord record)

Static Public Member Functions

static string HashPassword (string pass)

Properties

static Dictionary< string,
UserTypeData > 
UserTypes [get, set]
 This method Gets or Sets a list of all available user types.
static Dictionary< UserStatus,
UserStatusData > 
UserStatuses [get, set]
 This method Gets or Sets a list of all available user statuses.
new string Name [get, set]
 Gets and sets user data role name.
string Login [get, set]
 Gets and sets user name.
string Password [get, set]
 Gets and sets user password.
UserTypeData Type [get]
 Gets user type.
string TypeText [get, set]
 Gets and sets user type attribute as text.
UserStatus Status [get, set]
 Gets and sets user status.
UserStatusData StatusData [get]
 Gets UserStatusData object.
bool Locked [get]
 Gets true if user locked.
string Email [get, set]
 Gets and sets user email address.
string CompleteName [get, set]
 Gets and sets user's complete name.
string AddressLine1 [get, set]
 Gets and sets user's address (line 1).
string AddressLine2 [get, set]
 Gets and sets user's address (line 2).
string AddressLine3 [get, set]
 Gets and sets user's address (line 3).
string City [get, set]
 Gets and sets user's city.
string PostCode [get, set]
 Gets and sets user's post code.
bool FacilitySpecified [get]
 Gets indication whether the data role is specified through facility.
bool DataRoleSpecified [get]
 Gets indication whether the data role is specified explicitly through facility.
int DataRoleType [get, set]
 Gets and sets user data role type.
DataRole DataRole [get, set]
 Gets and sets user data role.
Facility Facility [get, set]
 Gets and sets user facility.
FunctionRole FunctionalRole [get, set]
 Gets and sets user functional role.
string Language [get, set]
 Gets and sets user's selected language.
bool Validator [get]
 This method Gets whether user is validator.
string AccountRequestComment [get, set]
 Gets and sets the comment for account request.
Message AccountRequest [get, set]
 Gets and sets the account request message.
bool IsActive [get, set]
 Gets and sets is user active flag.
int ID [get, set]
 Gets user id.
int Type [get, set]
 Gets and sets user type.
string DataRole [get, set]
 Gets and sets user data role.
string Facility [get, set]
 Gets and sets user facility.
string FunctionalRole [get, set]
 Gets and sets user functional role.

Detailed Description

This class encapsulates all user properties.

Definition at line 39 of file UserManagement.cs.


Member Enumeration Documentation

Enumerator:
DataRole 
Facility 
DataRole 
Facility 

Definition at line 42 of file UserManagement.cs.

Enumerator:
DataRole 
Facility 
DataRole 
Facility 

Definition at line 46 of file UserData.cs.

Enumerator:
Active 
NotActive 
LoggedOn 
Locked 
LoggedOff 

Definition at line 60 of file UserData.cs.

Enumerator:
Administrator 
Regulator 
RestrictedAccessRegulator 
Licensee 
Guest 
Other 
Admin 
Regulator 
Licensee 
PublicBody 
Guest 

Definition at line 47 of file UserManagement.cs.

Enumerator:
Administrator 
Regulator 
RestrictedAccessRegulator 
Licensee 
Guest 
Other 
Admin 
Regulator 
Licensee 
PublicBody 
Guest 

Definition at line 51 of file UserData.cs.


Constructor & Destructor Documentation

RAIS::Common::UserManagement::UserData::UserData ( )

Definition at line 339 of file UserData.cs.

RAIS::Common::UserManagement::UserData::UserData ( IDataRecord  record)

Definition at line 341 of file UserData.cs.

RAIS::Common::UserManagement::UserData::UserData ( )

Definition at line 184 of file UserManagement.cs.

RAIS::Common::UserManagement::UserData::UserData ( IDataRecord  record)

Definition at line 186 of file UserManagement.cs.


Member Function Documentation

bool RAIS::Common::UserManagement::UserData::HasAccessToCategory ( string  categoryName)

Definition at line 367 of file UserData.cs.

static string RAIS::Common::UserManagement::UserData::HashPassword ( string  pass) [static]

Definition at line 372 of file UserData.cs.

override string RAIS::Common::UserManagement::UserData::ToString ( )

Definition at line 383 of file UserData.cs.


Property Documentation

Message RAIS::Common::UserManagement::UserData::AccountRequest [get, set]

Gets and sets the account request message.

Definition at line 324 of file UserData.cs.

string RAIS::Common::UserManagement::UserData::AccountRequestComment [get, set]

Gets and sets the comment for account request.

Definition at line 316 of file UserData.cs.

string RAIS::Common::UserManagement::UserData::AddressLine1 [get, set]

Gets and sets user's address (line 1).

Definition at line 213 of file UserData.cs.

string RAIS::Common::UserManagement::UserData::AddressLine2 [get, set]

Gets and sets user's address (line 2).

Definition at line 221 of file UserData.cs.

string RAIS::Common::UserManagement::UserData::AddressLine3 [get, set]

Gets and sets user's address (line 3).

Definition at line 229 of file UserData.cs.

string RAIS::Common::UserManagement::UserData::City [get, set]

Gets and sets user's city.

Definition at line 237 of file UserData.cs.

string RAIS::Common::UserManagement::UserData::CompleteName [get, set]

Gets and sets user's complete name.

Definition at line 201 of file UserData.cs.

string RAIS::Common::UserManagement::UserData::DataRole [get, set]

Gets and sets user data role.

Definition at line 153 of file UserManagement.cs.

DataRole RAIS::Common::UserManagement::UserData::DataRole [get, set]

Gets and sets user data role.

Definition at line 275 of file UserData.cs.

bool RAIS::Common::UserManagement::UserData::DataRoleSpecified [get]

Gets indication whether the data role is specified explicitly through facility.

Definition at line 260 of file UserData.cs.

int RAIS::Common::UserManagement::UserData::DataRoleType [get, set]

Gets and sets user data role type.

Definition at line 267 of file UserData.cs.

string RAIS::Common::UserManagement::UserData::Email [get, set]

Gets and sets user email address.

Definition at line 193 of file UserData.cs.

string RAIS::Common::UserManagement::UserData::Facility [get, set]

Gets and sets user facility.

Definition at line 161 of file UserManagement.cs.

Facility RAIS::Common::UserManagement::UserData::Facility [get, set]

Gets and sets user facility.

Definition at line 283 of file UserData.cs.

bool RAIS::Common::UserManagement::UserData::FacilitySpecified [get]

Gets indication whether the data role is specified through facility.

Definition at line 253 of file UserData.cs.

string RAIS::Common::UserManagement::UserData::FunctionalRole [get, set]

Gets and sets user functional role.

Definition at line 169 of file UserManagement.cs.

FunctionRole RAIS::Common::UserManagement::UserData::FunctionalRole [get, set]

Gets and sets user functional role.

Definition at line 291 of file UserData.cs.

int RAIS::Common::UserManagement::UserData::ID [get, set]

Gets user id.

Reimplemented from RAIS::Common::DBObject.

Definition at line 74 of file UserManagement.cs.

bool RAIS::Common::UserManagement::UserData::IsActive [get, set]

Gets and sets is user active flag.

Definition at line 332 of file UserData.cs.

string RAIS::Common::UserManagement::UserData::Language [get, set]

Gets and sets user's selected language.

Definition at line 299 of file UserData.cs.

bool RAIS::Common::UserManagement::UserData::Locked [get]

Gets true if user locked.

Definition at line 186 of file UserData.cs.

string RAIS::Common::UserManagement::UserData::Login [get, set]

Gets and sets user name.

Definition at line 130 of file UserData.cs.

new string RAIS::Common::UserManagement::UserData::Name [get, set]

Gets and sets user data role name.

Reimplemented from RAIS::Common::DBObject.

Definition at line 118 of file UserData.cs.

string RAIS::Common::UserManagement::UserData::Password [get, set]

Gets and sets user password.

Definition at line 138 of file UserData.cs.

string RAIS::Common::UserManagement::UserData::PostCode [get, set]

Gets and sets user's post code.

Definition at line 245 of file UserData.cs.

UserStatus RAIS::Common::UserManagement::UserData::Status [get, set]

Gets and sets user status.

Definition at line 171 of file UserData.cs.

UserStatusData RAIS::Common::UserManagement::UserData::StatusData [get]

Gets UserStatusData object.

Definition at line 179 of file UserData.cs.

int RAIS::Common::UserManagement::UserData::Type [get, set]

Gets and sets user type.

Definition at line 98 of file UserManagement.cs.

UserTypeData RAIS::Common::UserManagement::UserData::Type [get]

Gets user type.

Definition at line 146 of file UserData.cs.

string RAIS::Common::UserManagement::UserData::TypeText [get, set]

Gets and sets user type attribute as text.

/*!

Definition at line 153 of file UserData.cs.

Dictionary<UserStatus, UserStatusData> RAIS::Common::UserManagement::UserData::UserStatuses [static, get, set]

This method Gets or Sets a list of all available user statuses.

Returns:
Dictionary of user status name vs UserStatusData objects

Definition at line 112 of file UserData.cs.

Dictionary<string, UserTypeData> RAIS::Common::UserManagement::UserData::UserTypes [static, get, set]

This method Gets or Sets a list of all available user types.

Returns:
Dictionary of user type name vs UserTypeData objects

Definition at line 102 of file UserData.cs.

bool RAIS::Common::UserManagement::UserData::Validator [get]

This method Gets whether user is validator.

Returns:
true if user is validator

Definition at line 309 of file UserData.cs.


The documentation for this class was generated from the following files: